home *** CD-ROM | disk | FTP | other *** search
/ Linux Cubed Series 2: Applications / Linux Cubed Series 2 - Applications.iso / editors / emacs / xemacs / xemacs-1.006 / xemacs-1 / lib / xemacs-19.13 / lisp / oobr / BR-README < prev    next >
Encoding:
Text File  |  1995-07-14  |  6.1 KB  |  160 lines
  1. # See "br-vers.el" for the OO-Browser Lisp Code Directory information.
  2. #
  3. # SUMMARY:      OO-Browser overview and installation notes
  4. #
  5. # AUTHOR:       Bob Weiner
  6. #
  7. # ORIG-DATE:    16-Jun-90
  8. # LAST-MOD:      1-Jun-95 at 10:14:11 by Bob Weiner
  9. #
  10. # Copyright (C) 1990-1995  Free Software Foundation, Inc.
  11. # See the file BR-COPY for license information.
  12. #
  13. # This file is part of the OO-Browser.
  14.  
  15. See the "BR-COPY" file for copying and distribution information.
  16.  
  17. See the "BR-OBTAIN" file for information on obtaining the OO-Browser.
  18.  
  19. See the "MANIFEST" file for summaries of the OO-Browser files.
  20.  
  21. See the "BR-RELEASE" file for a summary of new features in this release.
  22.  
  23. See the "BR-FEATURES" file for a summary of OO-Browser features.
  24.  
  25. "man/oo-browser.info" and "man/oo-browser.texi" contain the Info and Texinfo
  26. source versions of the OO-Browser User Manual.
  27.  
  28. ------
  29.  
  30. Mail List
  31.  
  32. oo-browser@hub.ucsb.edu            - mail list
  33. oo-browser-request@hub.ucsb.edu    - administrative requests
  34.  
  35.    The oo-browser mail list is for discussion, bug reports and feature
  36.    requests concerning the OO-Browser multi-language code browser.
  37.    If your Emacs version supports menubars and popup menus, you can use the
  38.    Compose-Mail-to-List and Mail-List-Request menu items to access the
  39.    mail list and administrative address, respectively, when in the OO-Browser.
  40.  
  41.    ALL mail concerning administration of the OO-Browser mailing list should
  42.    be sent to the -request address.  That includes addition, change, or
  43.    deletion requests.  Don't EVER consider sending such a request to the
  44.    oo-browser mail list.
  45.  
  46.    Use the following formats on your subject line to execute requests,
  47.    where you substitute your own values for the <> delimited items.
  48.  
  49.      Subject: Subscribe '<' <user@domain> '>' (<your name>).
  50.      Subject: Unsubscribe '<' <user@domain> '>'.
  51.  
  52.    To change your address, you must unsubscribe your old address in one
  53.    message and then subscribe your new address in another message.
  54.  
  55.    For example:
  56.  
  57.      To: oo-browser-request@hub.ucsb.edu
  58.      Subject: Unsubscribe <joe@any.com>.
  59.  
  60.      To: oo-browser-request@hub.ucsb.edu
  61.      Subject: Subscribe <joe@any.com> (Joe Williams).
  62.  
  63.    If you ask questions, you should consider adding to the discussion by
  64.    telling people the kinds of work you are doing or contemplating doing
  65.    with the OO-Browser.  In this way, the list will not be overwhelmed by
  66.    messages that ask for, but provide no information.
  67.  
  68. ------
  69.  
  70. To install the OO-Browser:
  71.  
  72.     If you have the Hyperbole system installed, you must be using
  73.     V3.18.4 or greater.  Otherwise, you must upgrade.  Get Hyperbole
  74.     from: /anonymous@cs.uiuc.edu:/pub/xemacs/infodock.  Get the h*
  75.     files in that directory.  Once you have this version installed,
  76.     you can safely delete the oobr/hypb/ directory, which duplicates a
  77.     subset of the Hyperbole files to provide the OO-Browser with
  78.     context-sensitive keyboard and mouse keys.  But then you must
  79.     make a symbolic link from your hyperbole directory to oobr/hypb,
  80.     so that the OO-Browser Makefile can see the Hyperbole files it needs.
  81.  
  82.     Add the full path of either the Hyperbole code directory or the
  83.     "oobr/hypb/" subdirectory to your 'load-path' variable.
  84.  
  85.     You may want to change the settings of 'c++-cpp-include-dirs'
  86.     and 'c++-include-dirs' at the bottom of "br-site.el".
  87.  
  88.     If you prefer to use some non-GNU Emacs editor such
  89.     as vi to view and edit your code, then modify to your taste the
  90.     settings in the br-setup-external function in "br-site.el" and add
  91.     the following line to your personal Emacs initialization file:
  92.     (add-hook 'br-mode-hook 'br-setup-external)
  93.  
  94.     Add the following lines to your site autoload configuration, substituting
  95.     the correct full path for <OOBR-DIR>:
  96.  
  97.        If you use any version of Emacs prior to V19, e.g. Emacs 18.59
  98.        or Epoch, then you must add the following line; don't add it to
  99.        Emacs 19 or XEmacs.  Note that the value must end with a `/'.
  100.          (setq br-directory "<OOBR-DIR>/")
  101.  
  102.        For any version of Emacs, aside from XEmacs 19.12 or greater (which
  103.        already includes these lines), add these lines:
  104.          (autoload 'oobr "<OOBR-DIR>/br-start" "Invoke the OO-Browser" t)
  105.          (autoload 'br-env-browse "<OOBR-DIR>/br-start"
  106.             "Browse an existing OO-Browser Environment" t)
  107.  
  108.     Add the following key binding to your site keys configuration:
  109.  
  110.        (global-set-key "\C-c\C-o" 'oobr)
  111.  
  112.  
  113.     The OO-Browser's Emacs Lisp files are pre-byte-compiled for InfoDock,
  114.     Emacs 19 and XEmacs, so if you run one of these versions, when you use
  115.     make to build the OO-Browser, very few files will need to be built, so
  116.     your make will finish quickly.
  117.  
  118.     Before doing your first make, edit the CONFIGURABLE SECTION in the
  119.     "Makefile".  You must set the EMACS variable to point to the Emacs
  120.     executable that you want to use to byte-compile the OO-Browser Lisp
  121.     files.  You may also have to set SITE-PRELOADS; follow the instructions
  122.     that precede the 'SITE-PRELOADS =' line.  Make these changes now and save
  123.     the Makefile.
  124.  
  125.     If you are running Emacs V18 or Epoch, you must first rebuild all
  126.     byte-compiled Lisp files.  Move to the oobr directory and use:
  127.            make all-elc
  128.  
  129.     Then, whatever Emacs version you use, move to the oobr directory
  130.     and use:
  131.        make
  132.  
  133.     Use these commands if you want to build graphical interfaces to
  134.     the OO-Browser:
  135.            If you want to build the X OO-Browser, you have to change some
  136.            of the variable settings at the top of the "tree-x/Makefile", such
  137.            as your InfoDock or Emacs bin directory.
  138.            Once you have done that, use:
  139.           make xoobr
  140.            to build the X OO-Browser.
  141.  
  142.            If you want to rebuild the NEXTSTEP OO-Browser below the
  143.            "tree-nx" directory, you must use NeXT's ProjectBuilder.  The
  144.            browser is pre-built for NEXTSTEP 3.0 on 68k NeXT machines.
  145.  
  146.     To produce the Postscript version of the Hyperbole manual:
  147.            make ps
  148.  
  149.     If you ever want to just rebuild out of data Lisp files, use:
  150.            make elc
  151.     
  152.     The OO-Browser is now ready for use.
  153.  
  154. ------
  155.  
  156. To invoke the OO-Browser, use:
  157.  
  158.     {C-c C-o} or {M-x oobr RET}
  159.  
  160.